Improve handling of rustdoc lints when used with raw doc fragments. #136400

lolbinarycat · 2025-02-01T21:03:51Z

rustdoc::bare_urls no longer outputs incoherent suggestions if source_span_for_markdown_range returns None, instead outputting no suggestion
source_span_for_markdown_range has one more heuristic, so it will return None less often.
add ui test to make sure we don't emit nonsense suggestions.

rustbot · 2025-02-01T21:03:58Z

rustbot has assigned @fmease.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

compiler/rustc_resolve/src/rustdoc.rs

lolbinarycat · 2025-02-06T22:07:45Z

@fmease what module do you want me to move source_span_to_markdown_range into, or should that be left for a followup PR?

lolbinarycat · 2025-03-13T20:09:34Z

@fmease reminder to look at this.

lolbinarycat · 2025-03-22T23:03:12Z

@fmease it's been a week, are you going to get to this, or should I reroll reviewers?

src/librustdoc/passes/lint/bare_urls.rs

compiler/rustc_resolve/src/rustdoc.rs

tests/rustdoc-ui/lints/bare-urls-limit.rs

fmease · 2025-04-02T12:16:41Z

@bors try @rust-timer queue

…1, r=<try> Improve handling of rustdoc lints when used with raw doc fragments. 1. `rustdoc::bare_urls` no longer outputs incoherent suggestions if `source_span_for_markdown_range` returns None, instead outputting no suggestion 2. `source_span_for_markdown_range` has one more heuristic, so it will return `None` less often. 3. add ui test to make sure we don't emit nonsense suggestions. fixes rust-lang#135851

bors · 2025-04-02T12:17:58Z

⌛ Trying commit c6d7696 with merge 75eefd1...

bors · 2025-04-02T14:24:42Z

☀️ Try build successful - checks-actions
Build commit: 75eefd1 (75eefd14476b7cd550f9b8b82f8fccfa949bf30e)

rust-timer · 2025-04-02T16:49:32Z

Finished benchmarking commit (75eefd1): comparison URL.

Overall result: no relevant changes - no action needed

Benchmarking this pull request likely means that it is perf-sensitive, so we're automatically marking it as not fit for rolling up. While you can manually mark this PR as fit for rollup, we strongly recommend not doing so since this PR may lead to changes in compiler perf.

@bors rollup=never
@rustbot label: -S-waiting-on-perf -perf-regression

Instruction count

This benchmark run did not return any relevant results for this metric.

Max RSS (memory usage)

Results (secondary -4.0%)

This is a less reliable metric that may be of interest but was not used to determine the overall result at the top of this comment.

	mean	range	count
Regressions ❌ (primary)	-	-	0
Regressions ❌ (secondary)	-	-	0
Improvements ✅ (primary)	-	-	0
Improvements ✅ (secondary)	-4.0%	[-5.0%, -3.0%]	2
All ❌✅ (primary)	-	-	0

Cycles

This benchmark run did not return any relevant results for this metric.

Binary size

This benchmark run did not return any relevant results for this metric.

Bootstrap: 776.227s -> 775.389s (-0.11%)
Artifact size: 365.99 MiB -> 365.98 MiB (-0.00%)

lolbinarycat · 2025-04-02T19:02:11Z

@fmease all recommended changes added

GuillaumeGomez · 2025-05-14T15:26:43Z

compiler/rustc_resolve/src/rustdoc.rs

+        let mut match_data = None;
+        let pat = &markdown[md_range.clone()];
+        // this heirustic doesn't make sense with a zero-sized range.
+        if pat.len() == 0 {


Suggested change

if pat.len() == 0 {

if pat.is_empty() {

GuillaumeGomez · 2025-05-14T15:27:05Z

compiler/rustc_resolve/src/rustdoc.rs

@@ -528,6 +536,38 @@ pub fn source_span_for_markdown_range(
    let is_all_sugared_doc = fragments.iter().all(|frag| frag.kind == DocFragmentKind::SugaredDoc);

    if !is_all_sugared_doc {
+        // this case ignores the markdown outside of the range so that it can


Suggested change

// this case ignores the markdown outside of the range so that it can

// This case ignores the markdown outside of the range so that it can

GuillaumeGomez · 2025-05-14T15:28:37Z

compiler/rustc_resolve/src/rustdoc.rs

+        // fragments.
+        let mut match_data = None;
+        let pat = &markdown[md_range.clone()];
+        // this heirustic doesn't make sense with a zero-sized range.


Suggested change

// this heirustic doesn't make sense with a zero-sized range.

// This heuristic doesn't make sense with a zero-sized range.

fmease · 2025-05-14T11:05:25Z

compiler/rustc_resolve/src/rustdoc.rs

 pub fn source_span_for_markdown_range(
    tcx: TyCtxt<'_>,
    markdown: &str,
    md_range: &Range<usize>,
    fragments: &[DocFragment],
 ) -> Option<Span> {
+    let span_to_snippet = |span| tcx.sess.source_map().span_to_snippet(span);


style: just do let map = tcx.sess.source_map(); and change call sites to map.snap_to_snippet(…), it's hardly longer

GuillaumeGomez · 2025-05-14T15:32:32Z

compiler/rustc_resolve/src/rustdoc.rs

+                // if there is either a match in a previous fragment,
+                // or multiple matches in this fragment,
+                // there is ambiguity.


Suggested change

// if there is either a match in a previous fragment,

// or multiple matches in this fragment,

// there is ambiguity.

// If there is either a match in a previous fragment, or

// multiple matches in this fragment, there is ambiguity.

GuillaumeGomez · 2025-05-14T15:33:10Z

compiler/rustc_resolve/src/rustdoc.rs

+            }
+        }
+        if let Some((i, match_start)) = match_data {
+            use rustc_span::BytePos;


Please move this import either at the beginning of the function or at the top of the file.

GuillaumeGomez · 2025-05-14T15:34:38Z

compiler/rustc_resolve/src/rustdoc.rs

+                if match_data.is_none() && !snippet[match_start + 1..].contains(pat) {
+                    match_data = Some((i, match_start));
+                } else {
+                    // heirustic produced ambiguity, return nothing.


Suggested change

// heirustic produced ambiguity, return nothing.

// Heuristic produced ambiguity, return nothing.

GuillaumeGomez · 2025-05-14T15:42:07Z

compiler/rustc_resolve/src/rustdoc.rs

+            let mut sp = fragments[i].span;
+            sp = sp.with_lo(sp.lo() + BytePos(match_start as u32));
+            sp = sp.with_hi(sp.lo() + BytePos((md_range.end - md_range.start) as u32));
+            return Some(sp);


Suggested change

let mut sp = fragments[i].span;

sp = sp.with_lo(sp.lo() + BytePos(match_start as u32));

sp = sp.with_hi(sp.lo() + BytePos((md_range.end - md_range.start) as u32));

return Some(sp);

return Some(fragments[i].span.with_lo(sp.lo() + BytePos(match_start as u32)).with_hi(sp.lo() + BytePos((md_range.end - md_range.start) as u32)));

GuillaumeGomez · 2025-05-14T15:43:11Z

src/librustdoc/passes/lint/bare_urls.rs

+            // the fallback of using the attribute span is suitable for
+            // highlighting where the error is, but not for placing the < and >


Suggested change

// the fallback of using the attribute span is suitable for

// highlighting where the error is, but not for placing the < and >

// The fallback of using the attribute span is suitable for

// highlighting where the error is, but not for placing the `<` and `>`.

GuillaumeGomez

Code logic is good, just some nits and then it's good to go.

lolbinarycat added 3 commits February 1, 2025 13:35

don't emit suggestion if link cannot be located

791f92c

partial fix for rust-lang#135851

add another heirustic to source_span_for_markdown_range

c802255

clarify doc comment on source_span_for_markdown_range

1b359d7

rustbot assigned fmease Feb 1, 2025

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Feb 1, 2025

This comment has been minimized.

Sign in to view

bless more tests

fc86385

This comment has been minimized.

Sign in to view

handle more edge cases

c6d7696

lolbinarycat force-pushed the rustdoc-link-lint-135851 branch from a9a435b to c6d7696 Compare February 3, 2025 19:23

petrochenkov reviewed Feb 3, 2025

View reviewed changes

compiler/rustc_resolve/src/rustdoc.rs Show resolved Hide resolved

lolbinarycat mentioned this pull request Feb 6, 2025

move tests from tests/rustdoc-ui/ to tests/rustdoc-ui/lints/ where applicable #136501

Open

fmease reviewed Apr 2, 2025

View reviewed changes

src/librustdoc/passes/lint/bare_urls.rs Outdated Show resolved Hide resolved

compiler/rustc_resolve/src/rustdoc.rs Show resolved Hide resolved

tests/rustdoc-ui/lints/bare-urls-limit.rs Outdated Show resolved Hide resolved

fmease closed this Apr 2, 2025

fmease reopened this Apr 2, 2025

This comment has been minimized.

Sign in to view

rustbot added the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Apr 2, 2025

This comment has been minimized.

Sign in to view

rustbot removed the S-waiting-on-perf Status: Waiting on a perf run to be completed. label Apr 2, 2025

rustdoc(rustdoc::bare_urls): apply code review suggestions

fe5bccb

GuillaumeGomez reviewed May 14, 2025

View reviewed changes

fmease reviewed May 14, 2025

View reviewed changes

GuillaumeGomez reviewed May 14, 2025

View reviewed changes

GuillaumeGomez requested changes May 14, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve handling of rustdoc lints when used with raw doc fragments. #136400

Improve handling of rustdoc lints when used with raw doc fragments. #136400

lolbinarycat commented Feb 1, 2025

rustbot commented Feb 1, 2025

This comment has been minimized.

This comment has been minimized.

lolbinarycat commented Feb 6, 2025

lolbinarycat commented Mar 13, 2025

lolbinarycat commented Mar 22, 2025

fmease commented Apr 2, 2025

This comment has been minimized.

bors commented Apr 2, 2025

bors commented Apr 2, 2025

This comment has been minimized.

rust-timer commented Apr 2, 2025

lolbinarycat commented Apr 2, 2025

GuillaumeGomez May 14, 2025

GuillaumeGomez May 14, 2025

GuillaumeGomez May 14, 2025 •

edited

Loading

fmease May 14, 2025

GuillaumeGomez May 14, 2025

GuillaumeGomez May 14, 2025

GuillaumeGomez May 14, 2025

GuillaumeGomez May 14, 2025

GuillaumeGomez May 14, 2025

GuillaumeGomez left a comment

	// this case ignores the markdown outside of the range so that it can
	// This case ignores the markdown outside of the range so that it can

	// this heirustic doesn't make sense with a zero-sized range.
	// This heuristic doesn't make sense with a zero-sized range.

	// heirustic produced ambiguity, return nothing.
	// Heuristic produced ambiguity, return nothing.

		// the fallback of using the attribute span is suitable for
		// highlighting where the error is, but not for placing the < and >

Improve handling of rustdoc lints when used with raw doc fragments. #136400

Are you sure you want to change the base?

Improve handling of rustdoc lints when used with raw doc fragments. #136400

Conversation

lolbinarycat commented Feb 1, 2025

rustbot commented Feb 1, 2025

This comment has been minimized.

This comment has been minimized.

lolbinarycat commented Feb 6, 2025

lolbinarycat commented Mar 13, 2025

lolbinarycat commented Mar 22, 2025

fmease commented Apr 2, 2025

This comment has been minimized.

bors commented Apr 2, 2025

bors commented Apr 2, 2025

This comment has been minimized.

rust-timer commented Apr 2, 2025

Overall result: no relevant changes - no action needed

lolbinarycat commented Apr 2, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuillaumeGomez May 14, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuillaumeGomez left a comment

Choose a reason for hiding this comment

GuillaumeGomez May 14, 2025 •

edited

Loading